/usr/share/dpdk/x86_64-default-linuxapp-gcc/include/rte_eth_bond_8023ad.h is in dpdk-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 | /*-
* BSD LICENSE
*
* Copyright(c) 2010-2014 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_8023AD_H_
#define RTE_ETH_BOND_8023AD_H_
#include <rte_ether.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* Actor/partner states
*/
#define STATE_LACP_ACTIVE 0x01
#define STATE_LACP_SHORT_TIMEOUT 0x02
#define STATE_AGGREGATION 0x04
#define STATE_SYNCHRONIZATION 0x08
#define STATE_COLLECTING 0x10
#define STATE_DISTRIBUTING 0x20
/** Partners parameters are defaulted */
#define STATE_DEFAULTED 0x40
#define STATE_EXPIRED 0x80
#define TLV_TYPE_ACTOR_INFORMATION 0x01
#define TLV_TYPE_PARTNER_INFORMATION 0x02
#define TLV_TYPE_COLLECTOR_INFORMATION 0x03
#define TLV_TYPE_TERMINATOR_INFORMATION 0x00
#define SLOW_SUBTYPE_LACP 0x01
#define SLOW_SUBTYPE_MARKER 0x02
#define MARKER_TLV_TYPE_INFO 0x01
#define MARKER_TLV_TYPE_RESP 0x02
typedef void (*rte_eth_bond_8023ad_ext_slowrx_fn)(uint16_t slave_id,
struct rte_mbuf *lacp_pkt);
enum rte_bond_8023ad_selection {
UNSELECTED,
STANDBY,
SELECTED
};
enum rte_bond_8023ad_agg_selection {
AGG_BANDWIDTH,
AGG_COUNT,
AGG_STABLE
};
/** Generic slow protocol structure */
struct slow_protocol {
uint8_t subtype;
uint8_t reserved_119[119];
} __attribute__((__packed__));
/** Generic slow protocol frame type structure */
struct slow_protocol_frame {
struct ether_hdr eth_hdr;
struct slow_protocol slow_protocol;
} __attribute__((__packed__));
struct port_params {
uint16_t system_priority;
/**< System priority (unused in current implementation) */
struct ether_addr system;
/**< System ID - Slave MAC address, same as bonding MAC address */
uint16_t key;
/**< Speed information (implementation dependednt) and duplex. */
uint16_t port_priority;
/**< Priority of this (unused in current implementation) */
uint16_t port_number;
/**< Port number. It corresponds to slave port id. */
} __attribute__((__packed__));
struct lacpdu_actor_partner_params {
uint8_t tlv_type_info;
uint8_t info_length;
struct port_params port_params;
uint8_t state;
uint8_t reserved_3[3];
} __attribute__((__packed__));
/** LACPDU structure (5.4.2 in 802.1AX documentation). */
struct lacpdu {
uint8_t subtype;
uint8_t version_number;
struct lacpdu_actor_partner_params actor;
struct lacpdu_actor_partner_params partner;
uint8_t tlv_type_collector_info;
uint8_t collector_info_length;
uint16_t collector_max_delay;
uint8_t reserved_12[12];
uint8_t tlv_type_terminator;
uint8_t terminator_length;
uint8_t reserved_50[50];
} __attribute__((__packed__));
/** LACPDU frame: Contains ethernet header and LACPDU. */
struct lacpdu_header {
struct ether_hdr eth_hdr;
struct lacpdu lacpdu;
} __attribute__((__packed__));
struct marker {
uint8_t subtype;
uint8_t version_number;
uint8_t tlv_type_marker;
uint8_t info_length;
uint16_t requester_port;
struct ether_addr requester_system;
uint32_t requester_transaction_id;
uint8_t reserved_2[2];
uint8_t tlv_type_terminator;
uint8_t terminator_length;
uint8_t reserved_90[90];
} __attribute__((__packed__));
struct marker_header {
struct ether_hdr eth_hdr;
struct marker marker;
} __attribute__((__packed__));
struct rte_eth_bond_8023ad_conf {
uint32_t fast_periodic_ms;
uint32_t slow_periodic_ms;
uint32_t short_timeout_ms;
uint32_t long_timeout_ms;
uint32_t aggregate_wait_timeout_ms;
uint32_t tx_period_ms;
uint32_t rx_marker_period_ms;
uint32_t update_timeout_ms;
rte_eth_bond_8023ad_ext_slowrx_fn slowrx_cb;
enum rte_bond_8023ad_agg_selection agg_selection;
};
struct rte_eth_bond_8023ad_slave_info {
enum rte_bond_8023ad_selection selected;
uint8_t actor_state;
struct port_params actor;
uint8_t partner_state;
struct port_params partner;
uint16_t agg_port_id;
};
/**
* @internal
*
* Function returns current configuration of 802.3AX mode.
*
* @param port_id Bonding device id
* @param conf Pointer to timeout structure.
*
* @return
* 0 - if ok
* -EINVAL if conf is NULL
*/
int
rte_eth_bond_8023ad_conf_get(uint16_t port_id,
struct rte_eth_bond_8023ad_conf *conf);
/**
* @internal
*
* Function set new configuration of 802.3AX mode.
*
* @param port_id Bonding device id
* @param conf Configuration, if NULL set default configuration.
* @return
* 0 - if ok
* -EINVAL if configuration is invalid.
*/
int
rte_eth_bond_8023ad_setup(uint16_t port_id,
struct rte_eth_bond_8023ad_conf *conf);
/**
* @internal
*
* Function returns current state of given slave device.
*
* @param slave_id Port id of valid slave.
* @param conf buffer for configuration
* @return
* 0 - if ok
* -EINVAL if conf is NULL or slave id is invalid (not a slave of given
* bonded device or is not inactive).
*/
int
rte_eth_bond_8023ad_slave_info(uint16_t port_id, uint16_t slave_id,
struct rte_eth_bond_8023ad_slave_info *conf);
#ifdef __cplusplus
}
#endif
/**
* Configure a slave port to start collecting.
*
* @param port_id Bonding device id
* @param slave_id Port id of valid slave.
* @param enabled Non-zero when collection enabled.
* @return
* 0 - if ok
* -EINVAL if slave is not valid.
*/
int
rte_eth_bond_8023ad_ext_collect(uint16_t port_id, uint16_t slave_id,
int enabled);
/**
* Get COLLECTING flag from slave port actor state.
*
* @param port_id Bonding device id
* @param slave_id Port id of valid slave.
* @return
* 0 - if not set
* 1 - if set
* -EINVAL if slave is not valid.
*/
int
rte_eth_bond_8023ad_ext_collect_get(uint16_t port_id, uint16_t slave_id);
/**
* Configure a slave port to start distributing.
*
* @param port_id Bonding device id
* @param slave_id Port id of valid slave.
* @param enabled Non-zero when distribution enabled.
* @return
* 0 - if ok
* -EINVAL if slave is not valid.
*/
int
rte_eth_bond_8023ad_ext_distrib(uint16_t port_id, uint16_t slave_id,
int enabled);
/**
* Get DISTRIBUTING flag from slave port actor state.
*
* @param port_id Bonding device id
* @param slave_id Port id of valid slave.
* @return
* 0 - if not set
* 1 - if set
* -EINVAL if slave is not valid.
*/
int
rte_eth_bond_8023ad_ext_distrib_get(uint16_t port_id, uint16_t slave_id);
/**
* LACPDU transmit path for external 802.3ad state machine. Caller retains
* ownership of the packet on failure.
*
* @param port_id Bonding device id
* @param slave_id Port ID of valid slave device.
* @param lacp_pkt mbuf containing LACPDU.
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_8023ad_ext_slowtx(uint16_t port_id, uint16_t slave_id,
struct rte_mbuf *lacp_pkt);
/**
* Enable dedicated hw queues for 802.3ad control plane traffic on on slaves
*
* This function creates an additional tx and rx queue on each slave for
* dedicated 802.3ad control plane traffic . A flow filtering rule is
* programmed on each slave to redirect all LACP slow packets to that rx queue
* for processing in the LACP state machine, this removes the need to filter
* these packets in the bonded devices data path. The additional tx queue is
* used to enable the LACP state machine to enqueue LACP packets directly to
* slave hw independently of the bonded devices data path.
*
* To use this feature all slaves must support the programming of the flow
* filter rule required for rx and have enough queues that one rx and tx queue
* can be reserved for the LACP state machines control packets.
*
* Bonding port must be stopped to change this configuration.
*
* @param port_id Bonding device id
*
* @return
* 0 on success, negative value otherwise.
*/
int
rte_eth_bond_8023ad_dedicated_queues_enable(uint16_t port_id);
/**
* Disable slow queue on slaves
*
* This function disables hardware slow packet filter.
*
* Bonding port must be stopped to change this configuration.
*
* @see rte_eth_bond_8023ad_slow_pkt_hw_filter_enable
*
* @param port_id Bonding device id
* @return
* 0 on success, negative value otherwise.
*
*/
int
rte_eth_bond_8023ad_dedicated_queues_disable(uint16_t port_id);
/*
* Get aggregator mode for 8023ad
* @param port_id Bonding device id
*
* @return
* agregator mode on success, negative value otherwise
*/
int
rte_eth_bond_8023ad_agg_selection_get(uint16_t port_id);
/**
* Set aggregator mode for 8023ad
* @param port_id Bonding device id
* @return
* 0 on success, negative value otherwise
*/
int
rte_eth_bond_8023ad_agg_selection_set(uint16_t port_id,
enum rte_bond_8023ad_agg_selection agg_selection);
#endif /* RTE_ETH_BOND_8023AD_H_ */
|