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 #define BONDING_MODE_BROADCAST                  (3)
  75 /**< Broadcast (Mode 3).
  76  * In this mode all transmitted packets will be transmitted on all available
  77  * active slaves of the bonded. */
  78 #define BONDING_MODE_8023AD                             (4)
  79 /**< 802.3AD (Mode 4).
  80  *
  81  * This mode provides auto negotiation/configuration
  82  * of peers and well as link status changes monitoring using out of band
  83  * LACP (link aggregation control protocol) messages. For further details of
  84  * LACP specification see the IEEE 802.3ad/802.1AX standards. It is also
  85  * described here
  86  * https://www.kernel.org/doc/Documentation/networking/bonding.txt.
  87  *
  88  * Important Usage Notes:
  89  * - for LACP mode to work the rx/tx burst functions must be invoked
  90  * at least once every 100ms, otherwise the out-of-band LACP messages will not
  91  * be handled with the expected latency and this may cause the link status to be
  92  * incorrectly marked as down or failure to correctly negotiate with peers.
  93  * - For optimal performance during initial handshaking the array of mbufs provided
  94  * to rx_burst should be at least 2 times the slave count size.
  95  *
  96  */
  97 #define BONDING_MODE_TLB        (5)
  98 /**< Adaptive TLB (Mode 5)
  99  * This mode provides an adaptive transmit load balancing. It dynamically
 100  * changes the transmitting slave, according to the computed load. Statistics
 101  * are collected in 100ms intervals and scheduled every 10ms */
 102 #define BONDING_MODE_ALB        (6)
 103 /**< Adaptive Load Balancing (Mode 6)
 104  * This mode includes adaptive TLB and receive load balancing (RLB). In RLB the
 105  * bonding driver intercepts ARP replies send by local system and overwrites its
 106  * source MAC address, so that different peers send data to the server on
 107  * different slave interfaces. When local system sends ARP request, it saves IP
 108  * information from it. When ARP reply from that peer is received, its MAC is
 109  * stored, one of slave MACs assigned and ARP reply send to that peer.
 110  */
 111
 112 /* Balance Mode Transmit Policies */
 113 #define BALANCE_XMIT_POLICY_LAYER2              (0)
 114 /**< Layer 2 (Ethernet MAC) */
 115 #define BALANCE_XMIT_POLICY_LAYER23             (1)
 116 /**< Layer 2+3 (Ethernet MAC + IP Addresses) transmit load balancing */
 117 #define BALANCE_XMIT_POLICY_LAYER34             (2)
 118 /**< Layer 3+4 (IP Addresses + UDP Ports) transmit load balancing */
 119
 120 /**
 121  * Create a bonded rte_eth_dev device
 122  *
 123  * @param name                  Name of new link bonding device.
 124  * @param mode                  Mode to initialize bonding device in.
 125  * @param socket_id             Socket Id on which to allocate eth_dev resources.
 126  *
 127  * @return
 128  *      Port Id of created rte_eth_dev on success, negative value otherwise
 129  */
 130 int
 131 rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id);
 132
 133 /**
 134  * Add a rte_eth_dev device as a slave to the bonded device
 135  *
 136  * @param bonded_port_id        Port ID of bonded device.
 137  * @param slave_port_id         Port ID of slave device.
 138  *
 139  * @return
 140  *      0 on success, negative value otherwise
 141  */
 142 int
 143 rte_eth_bond_slave_add(uint8_t bonded_port_id, uint8_t slave_port_id);
 144
 145 /**
 146  * Remove a slave rte_eth_dev device from the bonded device
 147  *
 148  * @param bonded_port_id        Port ID of bonded device.
 149  * @param slave_port_id         Port ID of slave device.
 150  *
 151  * @return
 152  *      0 on success, negative value otherwise
 153  */
 154 int
 155 rte_eth_bond_slave_remove(uint8_t bonded_port_id, uint8_t slave_port_id);
 156
 157 /**
 158  * Set link bonding mode of bonded device
 159  *
 160  * @param bonded_port_id        Port ID of bonded device.
 161  * @param mode                          Bonding mode to set
 162  *
 163  * @return
 164  *      0 on success, negative value otherwise
 165  */
 166 int
 167 rte_eth_bond_mode_set(uint8_t bonded_port_id, uint8_t mode);
 168
 169 /**
 170  * Get link bonding mode of bonded device
 171  *
 172  * @param bonded_port_id        Port ID of bonded device.
 173  *
 174  * @return
 175  *      link bonding mode on success, negative value otherwise
 176  */
 177 int
 178 rte_eth_bond_mode_get(uint8_t bonded_port_id);
 179
 180 /**
 181  * Set slave rte_eth_dev as primary slave of bonded device
 182  *
 183  * @param bonded_port_id        Port ID of bonded device.
 184  * @param slave_port_id         Port ID of slave device.
 185  *
 186  * @return
 187  *      0 on success, negative value otherwise
 188  */
 189 int
 190 rte_eth_bond_primary_set(uint8_t bonded_port_id, uint8_t slave_port_id);
 191
 192 /**
 193  * Get primary slave of bonded device
 194  *
 195  * @param bonded_port_id        Port ID of bonded device.
 196  *
 197  * @return
 198  *      Port Id of primary slave on success, -1 on failure
 199  */
 200 int
 201 rte_eth_bond_primary_get(uint8_t bonded_port_id);
 202
 203 /**
 204  * Populate an array with list of the slaves port id's of the bonded device
 205  *
 206  * @param bonded_port_id        Port ID of bonded eth_dev to interrogate
 207  * @param slaves                        Array to be populated with the current active slaves
 208  * @param len                           Length of slaves array
 209  *
 210  * @return
 211  *      Number of slaves associated with bonded device on success,
 212  *      negative value otherwise
 213  */
 214 int
 215 rte_eth_bond_slaves_get(uint8_t bonded_port_id, uint8_t slaves[], uint8_t len);
 216
 217 /**
 218  * Populate an array with list of the active slaves port id's of the bonded
 219  * device.
 220  *
 221  * @param bonded_port_id        Port ID of bonded eth_dev to interrogate
 222  * @param slaves                        Array to be populated with the current active slaves
 223  * @param len                           Length of slaves array
 224  *
 225  * @return
 226  *      Number of active slaves associated with bonded device on success,
 227  *      negative value otherwise
 228  */
 229 int
 230 rte_eth_bond_active_slaves_get(uint8_t bonded_port_id, uint8_t slaves[],
 231                 uint8_t len);
 232
 233 /**
 234  * Set explicit MAC address to use on bonded device and it's slaves.
 235  *
 236  * @param bonded_port_id        Port ID of bonded device.
 237  * @param mac_addr                      MAC Address to use on bonded device overriding
 238  *                                                      slaves MAC addresses
 239  *
 240  * @return
 241  *      0 on success, negative value otherwise
 242  */
 243 int
 244 rte_eth_bond_mac_address_set(uint8_t bonded_port_id,
 245                 struct ether_addr *mac_addr);
 246
 247 /**
 248  * Reset bonded device to use MAC from primary slave on bonded device and it's
 249  * slaves.
 250  *
 251  * @param bonded_port_id        Port ID of bonded device.
 252  *
 253  * @return
 254  *      0 on success, negative value otherwise
 255  */
 256 int
 257 rte_eth_bond_mac_address_reset(uint8_t bonded_port_id);
 258
 259 /**
 260  * Set the transmit policy for bonded device to use when it is operating in
 261  * balance mode, this parameter is otherwise ignored in other modes of
 262  * operation.
 263  *
 264  * @param bonded_port_id        Port ID of bonded device.
 265  * @param policy                        Balance mode transmission policy.
 266  *
 267  * @return
 268  *      0 on success, negative value otherwise.
 269  */
 270 int
 271 rte_eth_bond_xmit_policy_set(uint8_t bonded_port_id, uint8_t policy);
 272
 273 /**
 274  * Get the transmit policy set on bonded device for balance mode operation
 275  *
 276  * @param bonded_port_id        Port ID of bonded device.
 277  *
 278  * @return
 279  *      Balance transmit policy on success, negative value otherwise.
 280  */
 281 int
 282 rte_eth_bond_xmit_policy_get(uint8_t bonded_port_id);
 283
 284 /**
 285  * Set the link monitoring frequency (in ms) for monitoring the link status of
 286  * slave devices
 287  *
 288  * @param bonded_port_id        Port ID of bonded device.
 289  * @param internal_ms           Monitoring interval in milliseconds
 290  *
 291  * @return
 292  *      0 on success, negative value otherwise.
 293  */
 294
 295 int
 296 rte_eth_bond_link_monitoring_set(uint8_t bonded_port_id, uint32_t internal_ms);
 297
 298 /**
 299  * Get the current link monitoring frequency (in ms) for monitoring of the link
 300  * status of slave devices
 301  *
 302  * @param bonded_port_id        Port ID of bonded device.
 303  *
 304  * @return
 305  *      Monitoring interval on success, negative value otherwise.
 306  */
 307 int
 308 rte_eth_bond_link_monitoring_get(uint8_t bonded_port_id);
 309
 310
 311 /**
 312  * Set the period in milliseconds for delaying the disabling of a bonded link
 313  * when the link down status has been detected
 314  *
 315  * @param bonded_port_id        Port ID of bonded device.
 316  * @param delay_ms                      Delay period in milliseconds.
 317  *
 318  * @return
 319  *  0 on success, negative value otherwise.
 320  */
 321 int
 322 rte_eth_bond_link_down_prop_delay_set(uint8_t bonded_port_id, uint32_t delay_ms);
 323
 324 /**
 325  * Get the period in milliseconds set for delaying the disabling of a bonded
 326  * link when the link down status has been detected
 327  *
 328  * @param bonded_port_id        Port ID of bonded device.
 329  *
 330  * @return
 331  *  Delay period on success, negative value otherwise.
 332  */
 333 int
 334 rte_eth_bond_link_down_prop_delay_get(uint8_t bonded_port_id);
 335
 336 /**
 337  * Set the period in milliseconds for delaying the enabling of a bonded link
 338  * when the link up status has been detected
 339  *
 340  * @param bonded_port_id        Port ID of bonded device.
 341  * @param delay_ms                      Delay period in milliseconds.
 342  *
 343  * @return
 344  *  0 on success, negative value otherwise.
 345  */
 346 int
 347 rte_eth_bond_link_up_prop_delay_set(uint8_t bonded_port_id, uint32_t delay_ms);
 348
 349 /**
 350  * Get the period in milliseconds set for delaying the enabling of a bonded
 351  * link when the link up status has been detected
 352  *
 353  * @param bonded_port_id        Port ID of bonded device.
 354  *
 355  * @return
 356  *  Delay period on success, negative value otherwise.
 357  */
 358 int
 359 rte_eth_bond_link_up_prop_delay_get(uint8_t bonded_port_id);
 360
 361
 362 #ifdef __cplusplus
 363 }
 364 #endif
 365
 366 #endif