/usr/include/dpdk/rte_eth_bond.h is in libdpdk-dev 17.11.1-6.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 | /*-
* BSD LICENSE
*
* Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _RTE_ETH_BOND_H_
#define _RTE_ETH_BOND_H_
/**
* @file rte_eth_bond.h
*
* RTE Link Bonding Ethernet Device
* Link Bonding for 1GbE and 10GbE ports to allow the aggregation of multiple
* (slave) NICs into a single logical interface. The bonded device processes
* these interfaces based on the mode of operation specified and supported.
* This implementation supports 4 modes of operation round robin, active backup
* balance and broadcast. Providing redundant links, fault tolerance and/or
* load balancing of network ports
*/
#ifdef __cplusplus
extern "C" {
#endif
#include <rte_ether.h>
/* Supported modes of operation of link bonding library */
#define BONDING_MODE_ROUND_ROBIN (0)
/**< Round Robin (Mode 0).
* In this mode all transmitted packets will be balanced equally across all
* active slaves of the bonded in a round robin fashion. */
#define BONDING_MODE_ACTIVE_BACKUP (1)
/**< Active Backup (Mode 1).
* In this mode all packets transmitted will be transmitted on the primary
* slave until such point as the primary slave is no longer available and then
* transmitted packets will be sent on the next available slaves. The primary
* slave can be defined by the user but defaults to the first active slave
* available if not specified. */
#define BONDING_MODE_BALANCE (2)
/**< Balance (Mode 2).
* In this mode all packets transmitted will be balanced across the available
* slaves using one of three available transmit policies - l2, l2+3 or l3+4.
* See BALANCE_XMIT_POLICY macros definitions for further details on transmit
* policies. */
#define BONDING_MODE_BROADCAST (3)
/**< Broadcast (Mode 3).
* In this mode all transmitted packets will be transmitted on all available
* active slaves of the bonded. */
#define BONDING_MODE_8023AD (4)
/**< 802.3AD (Mode 4).
*
* This mode provides auto negotiation/configuration
* of peers and well as link status changes monitoring using out of band
* LACP (link aggregation control protocol) messages. For further details of
* LACP specification see the IEEE 802.3ad/802.1AX standards. It is also
* described here
* https://www.kernel.org/doc/Documentation/networking/bonding.txt.
*
* Important Usage Notes:
* - for LACP mode to work the rx/tx burst functions must be invoked
* at least once every 100ms, otherwise the out-of-band LACP messages will not
* be handled with the expected latency and this may cause the link status to be
* incorrectly marked as down or failure to correctly negotiate with peers.
* - For optimal performance during initial handshaking the array of mbufs provided
* to rx_burst should be at least 2 times the slave count size.
*
*/
#define BONDING_MODE_TLB (5)
/**< Adaptive TLB (Mode 5)
* This mode provides an adaptive transmit load balancing. It dynamically
* changes the transmitting slave, according to the computed load. Statistics
* are collected in 100ms intervals and scheduled every 10ms */
#define BONDING_MODE_ALB (6)
/**< Adaptive Load Balancing (Mode 6)
* This mode includes adaptive TLB and receive load balancing (RLB). In RLB the
* bonding driver intercepts ARP replies send by local system and overwrites its
* source MAC address, so that different peers send data to the server on
* different slave interfaces. When local system sends ARP request, it saves IP
* information from it. When ARP reply from that peer is received, its MAC is
* stored, one of slave MACs assigned and ARP reply send to that peer.
*/
/* Balance Mode Transmit Policies */
#define BALANCE_XMIT_POLICY_LAYER2 (0)
/**< Layer 2 (Ethernet MAC) */
#define BALANCE_XMIT_POLICY_LAYER23 (1)
/**< Layer 2+3 (Ethernet MAC + IP Addresses) transmit load balancing */
#define BALANCE_XMIT_POLICY_LAYER34 (2)
/**< Layer 3+4 (IP Addresses + UDP Ports) transmit load balancing */
/**
* Create a bonded rte_eth_dev device
*
* @param name Name of new link bonding device.
* @param mode Mode to initialize bonding device in.
* @param socket_id Socket Id on which to allocate eth_dev resources.
*
* @return
* Port Id of created rte_eth_dev on success, negative value otherwise
*/
int
rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id);
/**
* Free a bonded rte_eth_dev device
*
* @param name Name of the link bonding device.
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_free(const char *name);
/**
* Add a rte_eth_dev device as a slave to the bonded device
*
* @param bonded_port_id Port ID of bonded device.
* @param slave_port_id Port ID of slave device.
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_slave_add(uint16_t bonded_port_id, uint16_t slave_port_id);
/**
* Remove a slave rte_eth_dev device from the bonded device
*
* @param bonded_port_id Port ID of bonded device.
* @param slave_port_id Port ID of slave device.
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_slave_remove(uint16_t bonded_port_id, uint16_t slave_port_id);
/**
* Set link bonding mode of bonded device
*
* @param bonded_port_id Port ID of bonded device.
* @param mode Bonding mode to set
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_mode_set(uint16_t bonded_port_id, uint8_t mode);
/**
* Get link bonding mode of bonded device
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* link bonding mode on success, negative value otherwise
*/
int
rte_eth_bond_mode_get(uint16_t bonded_port_id);
/**
* Set slave rte_eth_dev as primary slave of bonded device
*
* @param bonded_port_id Port ID of bonded device.
* @param slave_port_id Port ID of slave device.
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_primary_set(uint16_t bonded_port_id, uint16_t slave_port_id);
/**
* Get primary slave of bonded device
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* Port Id of primary slave on success, -1 on failure
*/
int
rte_eth_bond_primary_get(uint16_t bonded_port_id);
/**
* Populate an array with list of the slaves port id's of the bonded device
*
* @param bonded_port_id Port ID of bonded eth_dev to interrogate
* @param slaves Array to be populated with the current active slaves
* @param len Length of slaves array
*
* @return
* Number of slaves associated with bonded device on success,
* negative value otherwise
*/
int
rte_eth_bond_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
uint16_t len);
/**
* Populate an array with list of the active slaves port id's of the bonded
* device.
*
* @param bonded_port_id Port ID of bonded eth_dev to interrogate
* @param slaves Array to be populated with the current active slaves
* @param len Length of slaves array
*
* @return
* Number of active slaves associated with bonded device on success,
* negative value otherwise
*/
int
rte_eth_bond_active_slaves_get(uint16_t bonded_port_id, uint16_t slaves[],
uint16_t len);
/**
* Set explicit MAC address to use on bonded device and it's slaves.
*
* @param bonded_port_id Port ID of bonded device.
* @param mac_addr MAC Address to use on bonded device overriding
* slaves MAC addresses
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_mac_address_set(uint16_t bonded_port_id,
struct ether_addr *mac_addr);
/**
* Reset bonded device to use MAC from primary slave on bonded device and it's
* slaves.
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_mac_address_reset(uint16_t bonded_port_id);
/**
* Set the transmit policy for bonded device to use when it is operating in
* balance mode, this parameter is otherwise ignored in other modes of
* operation.
*
* @param bonded_port_id Port ID of bonded device.
* @param policy Balance mode transmission policy.
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_xmit_policy_set(uint16_t bonded_port_id, uint8_t policy);
/**
* Get the transmit policy set on bonded device for balance mode operation
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* Balance transmit policy on success, negative value otherwise.
*/
int
rte_eth_bond_xmit_policy_get(uint16_t bonded_port_id);
/**
* Set the link monitoring frequency (in ms) for monitoring the link status of
* slave devices
*
* @param bonded_port_id Port ID of bonded device.
* @param internal_ms Monitoring interval in milliseconds
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_link_monitoring_set(uint16_t bonded_port_id, uint32_t internal_ms);
/**
* Get the current link monitoring frequency (in ms) for monitoring of the link
* status of slave devices
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* Monitoring interval on success, negative value otherwise.
*/
int
rte_eth_bond_link_monitoring_get(uint16_t bonded_port_id);
/**
* Set the period in milliseconds for delaying the disabling of a bonded link
* when the link down status has been detected
*
* @param bonded_port_id Port ID of bonded device.
* @param delay_ms Delay period in milliseconds.
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_link_down_prop_delay_set(uint16_t bonded_port_id,
uint32_t delay_ms);
/**
* Get the period in milliseconds set for delaying the disabling of a bonded
* link when the link down status has been detected
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* Delay period on success, negative value otherwise.
*/
int
rte_eth_bond_link_down_prop_delay_get(uint16_t bonded_port_id);
/**
* Set the period in milliseconds for delaying the enabling of a bonded link
* when the link up status has been detected
*
* @param bonded_port_id Port ID of bonded device.
* @param delay_ms Delay period in milliseconds.
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_link_up_prop_delay_set(uint16_t bonded_port_id,
uint32_t delay_ms);
/**
* Get the period in milliseconds set for delaying the enabling of a bonded
* link when the link up status has been detected
*
* @param bonded_port_id Port ID of bonded device.
*
* @return
* Delay period on success, negative value otherwise.
*/
int
rte_eth_bond_link_up_prop_delay_get(uint16_t bonded_port_id);
#ifdef __cplusplus
}
#endif
#endif
|