4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _RTE_ETH_BOND_H_
35 #define _RTE_ETH_BOND_H_
38 * @file rte_eth_bond.h
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
53 #include <rte_ether.h>
55 /* Supported modes of operation of link bonding library */
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
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. */
79 /* Balance Mode Transmit Policies */
80 #define BALANCE_XMIT_POLICY_LAYER2 (0)
81 /**< Layer 2 (Ethernet MAC) */
82 #define BALANCE_XMIT_POLICY_LAYER23 (1)
83 /**< Layer 2+3 (Ethernet MAC + IP Addresses) transmit load balancing */
84 #define BALANCE_XMIT_POLICY_LAYER34 (2)
85 /**< Layer 3+4 (IP Addresses + UDP Ports) transmit load balancing */
88 * Create a bonded rte_eth_dev device
90 * @param name Name of new link bonding device.
91 * @param mode Mode to initialize bonding device in.
92 * @param socket_id Socket Id on which to allocate eth_dev resources.
95 * Port Id of created rte_eth_dev on success, negative value otherwise
98 rte_eth_bond_create(const char *name, uint8_t mode, uint8_t socket_id);
101 * Add a rte_eth_dev device as a slave to the bonded device
103 * @param bonded_port_id Port ID of bonded device.
104 * @param slave_port_id Port ID of slave device.
107 * 0 on success, negative value otherwise
110 rte_eth_bond_slave_add(uint8_t bonded_port_id, uint8_t slave_port_id);
113 * Remove a slave rte_eth_dev device from the bonded device
115 * @param bonded_port_id Port ID of bonded device.
116 * @param slave_port_id Port ID of slave device.
119 * 0 on success, negative value otherwise
122 rte_eth_bond_slave_remove(uint8_t bonded_port_id, uint8_t slave_port_id);
125 * Set link bonding mode of bonded device
127 * @param bonded_port_id Port ID of bonded device.
128 * @param mode Bonding mode to set
131 * 0 on success, negative value otherwise
134 rte_eth_bond_mode_set(uint8_t bonded_port_id, uint8_t mode);
137 * Get link bonding mode of bonded device
139 * @param bonded_port_id Port ID of bonded device.
142 * link bonding mode on success, negative value otherwise
145 rte_eth_bond_mode_get(uint8_t bonded_port_id);
148 * Set slave rte_eth_dev as primary slave of bonded device
150 * @param bonded_port_id Port ID of bonded device.
151 * @param slave_port_id Port ID of slave device.
154 * 0 on success, negative value otherwise
157 rte_eth_bond_primary_set(uint8_t bonded_port_id, uint8_t slave_port_id);
160 * Get primary slave of bonded device
162 * @param bonded_port_id Port ID of bonded device.
165 * Port Id of primary slave on success, -1 on failure
168 rte_eth_bond_primary_get(uint8_t bonded_port_id);
171 * Populate an array with list of the slaves port id's of the bonded device
173 * @param bonded_port_id Port ID of bonded eth_dev to interrogate
174 * @param slaves Array to be populated with the current active slaves
175 * @param len Length of slaves array
178 * Number of slaves associated with bonded device on success,
179 * negative value otherwise
182 rte_eth_bond_slaves_get(uint8_t bonded_port_id, uint8_t slaves[], uint8_t len);
185 * Populate an array with list of the active slaves port id's of the bonded
188 * @param bonded_port_id Port ID of bonded eth_dev to interrogate
189 * @param slaves Array to be populated with the current active slaves
190 * @param len Length of slaves array
193 * Number of active slaves associated with bonded device on success,
194 * negative value otherwise
197 rte_eth_bond_active_slaves_get(uint8_t bonded_port_id, uint8_t slaves[],
201 * Set explicit MAC address to use on bonded device and it's slaves.
203 * @param bonded_port_id Port ID of bonded device.
204 * @param mac_addr MAC Address to use on bonded device overriding
205 * slaves MAC addresses
208 * 0 on success, negative value otherwise
211 rte_eth_bond_mac_address_set(uint8_t bonded_port_id,
212 struct ether_addr *mac_addr);
215 * Reset bonded device to use MAC from primary slave on bonded device and it's
218 * @param bonded_port_id Port ID of bonded device.
221 * 0 on success, negative value otherwise
224 rte_eth_bond_mac_address_reset(uint8_t bonded_port_id);
227 * Set the transmit policy for bonded device to use when it is operating in
228 * balance mode, this parameter is otherwise ignored in other modes of
231 * @param bonded_port_id Port ID of bonded device.
232 * @param policy Balance mode transmission policy.
235 * 0 on success, negative value otherwise.
238 rte_eth_bond_xmit_policy_set(uint8_t bonded_port_id, uint8_t policy);
241 * Get the transmit policy set on bonded device for balance mode operation
243 * @param bonded_port_id Port ID of bonded device.
246 * Balance transmit policy on success, negative value otherwise.
249 rte_eth_bond_xmit_policy_get(uint8_t bonded_port_id);