DPDK  2.1.0
rte_eth_bond_private.h
1 /*-
2  * BSD LICENSE
3  *
4  * Copyright(c) 2010-2015 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_PRIVATE_H_
35 #define _RTE_ETH_BOND_PRIVATE_H_
36 
37 #include <rte_ethdev.h>
38 #include <rte_spinlock.h>
39 
40 #include "rte_eth_bond.h"
41 #include "rte_eth_bond_8023ad_private.h"
42 #include "rte_eth_bond_alb.h"
43 
44 #define PMD_BOND_SLAVE_PORT_KVARG ("slave")
45 #define PMD_BOND_PRIMARY_SLAVE_KVARG ("primary")
46 #define PMD_BOND_MODE_KVARG ("mode")
47 #define PMD_BOND_XMIT_POLICY_KVARG ("xmit_policy")
48 #define PMD_BOND_SOCKET_ID_KVARG ("socket_id")
49 #define PMD_BOND_MAC_ADDR_KVARG ("mac")
50 #define PMD_BOND_LSC_POLL_PERIOD_KVARG ("lsc_poll_period_ms")
51 #define PMD_BOND_LINK_UP_PROP_DELAY_KVARG ("up_delay")
52 #define PMD_BOND_LINK_DOWN_PROP_DELAY_KVARG ("down_delay")
53 
54 #define PMD_BOND_XMIT_POLICY_LAYER2_KVARG ("l2")
55 #define PMD_BOND_XMIT_POLICY_LAYER23_KVARG ("l23")
56 #define PMD_BOND_XMIT_POLICY_LAYER34_KVARG ("l34")
57 
58 #define RTE_BOND_LOG(lvl, msg, ...) \
59  RTE_LOG(lvl, PMD, "%s(%d) - " msg "\n", __func__, __LINE__, ##__VA_ARGS__)
60 
61 #define BONDING_MODE_INVALID 0xFF
62 
63 extern const char *pmd_bond_init_valid_arguments[];
64 
65 extern const char pmd_bond_driver_name[];
66 
68 struct bond_rx_queue {
69  uint16_t queue_id;
71  struct bond_dev_private *dev_private;
73  uint16_t nb_rx_desc;
75  struct rte_eth_rxconf rx_conf;
77  struct rte_mempool *mb_pool;
79 };
80 
81 struct bond_tx_queue {
82  uint16_t queue_id;
84  struct bond_dev_private *dev_private;
86  uint16_t nb_tx_desc;
88  struct rte_eth_txconf tx_conf;
90 };
91 
93 struct bond_ethdev_slave_ports {
94  uint8_t slaves[RTE_MAX_ETHPORTS];
95  uint8_t slave_count;
96 };
97 
98 struct bond_slave_details {
99  uint8_t port_id;
100 
101  uint8_t link_status_poll_enabled;
102  uint8_t link_status_wait_to_complete;
103  uint8_t last_link_status;
105  struct ether_addr persisted_mac_addr;
106 };
107 
108 
109 typedef uint16_t (*xmit_hash_t)(const struct rte_mbuf *buf, uint8_t slave_count);
110 
112 struct bond_dev_private {
113  uint8_t port_id;
114  uint8_t mode;
116  rte_spinlock_t lock;
117 
118  uint8_t primary_port;
119  uint8_t current_primary_port;
120  uint8_t user_defined_primary_port;
123  uint8_t balance_xmit_policy;
125  xmit_hash_t xmit_hash;
128  uint8_t user_defined_mac;
130  uint8_t promiscuous_en;
132  uint8_t link_props_set;
135  uint8_t link_status_polling_enabled;
136  uint32_t link_status_polling_interval_ms;
137 
138  uint32_t link_down_delay_ms;
139  uint32_t link_up_delay_ms;
140 
141  uint16_t nb_rx_queues;
142  uint16_t nb_tx_queues;
144  uint8_t active_slave_count;
145  uint8_t active_slaves[RTE_MAX_ETHPORTS];
147  uint8_t slave_count;
148  struct bond_slave_details slaves[RTE_MAX_ETHPORTS];
151  struct mode8023ad_private mode4;
152  uint8_t tlb_slaves_order[RTE_MAX_ETHPORTS]; /* TLB active slaves send order */
153  struct mode_alb_private mode6;
154 
155  uint32_t rx_offload_capa;
156  uint32_t tx_offload_capa;
158  struct rte_kvargs *kvlist;
159  uint8_t slave_update_idx;
160 };
161 
162 extern struct eth_dev_ops default_dev_ops;
163 
164 int
165 valid_bonded_ethdev(const struct rte_eth_dev *eth_dev);
166 
167 /* Search given slave array to find possition of given id.
168  * Return slave pos or slaves_count if not found. */
169 static inline uint8_t
170 find_slave_by_id(uint8_t *slaves, uint8_t slaves_count, uint8_t slave_id) {
171 
172  uint8_t pos;
173  for (pos = 0; pos < slaves_count; pos++) {
174  if (slave_id == slaves[pos])
175  break;
176  }
177 
178  return pos;
179 }
180 
181 int
182 valid_port_id(uint8_t port_id);
183 
184 int
185 valid_bonded_port_id(uint8_t port_id);
186 
187 int
188 valid_slave_port_id(uint8_t port_id);
189 
190 void
191 deactivate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
192 
193 void
194 activate_slave(struct rte_eth_dev *eth_dev, uint8_t port_id);
195 
196 void
197 link_properties_set(struct rte_eth_dev *bonded_eth_dev,
198  struct rte_eth_link *slave_dev_link);
199 void
200 link_properties_reset(struct rte_eth_dev *bonded_eth_dev);
201 
202 int
203 link_properties_valid(struct rte_eth_link *bonded_dev_link,
204  struct rte_eth_link *slave_dev_link);
205 
206 int
207 mac_address_set(struct rte_eth_dev *eth_dev, struct ether_addr *new_mac_addr);
208 
209 int
210 mac_address_get(struct rte_eth_dev *eth_dev, struct ether_addr *dst_mac_addr);
211 
212 int
213 mac_address_slaves_update(struct rte_eth_dev *bonded_eth_dev);
214 
215 uint8_t
216 number_of_sockets(void);
217 
218 int
219 bond_ethdev_mode_set(struct rte_eth_dev *eth_dev, int mode);
220 
221 int
222 slave_configure(struct rte_eth_dev *bonded_eth_dev,
223  struct rte_eth_dev *slave_eth_dev);
224 
225 void
226 slave_remove(struct bond_dev_private *internals,
227  struct rte_eth_dev *slave_eth_dev);
228 
229 void
230 slave_add(struct bond_dev_private *internals,
231  struct rte_eth_dev *slave_eth_dev);
232 
233 uint16_t
234 xmit_l2_hash(const struct rte_mbuf *buf, uint8_t slave_count);
235 
236 uint16_t
237 xmit_l23_hash(const struct rte_mbuf *buf, uint8_t slave_count);
238 
239 uint16_t
240 xmit_l34_hash(const struct rte_mbuf *buf, uint8_t slave_count);
241 
242 void
243 bond_ethdev_primary_set(struct bond_dev_private *internals,
244  uint8_t slave_port_id);
245 
246 void
247 bond_ethdev_lsc_event_callback(uint8_t port_id, enum rte_eth_event_type type,
248  void *param);
249 
250 int
251 bond_ethdev_parse_slave_port_kvarg(const char *key __rte_unused,
252  const char *value, void *extra_args);
253 
254 int
255 bond_ethdev_parse_slave_mode_kvarg(const char *key __rte_unused,
256  const char *value, void *extra_args);
257 
258 int
259 bond_ethdev_parse_socket_id_kvarg(const char *key __rte_unused,
260  const char *value, void *extra_args);
261 
262 int
263 bond_ethdev_parse_primary_slave_port_id_kvarg(const char *key __rte_unused,
264  const char *value, void *extra_args);
265 
266 int
267 bond_ethdev_parse_balance_xmit_policy_kvarg(const char *key __rte_unused,
268  const char *value, void *extra_args);
269 
270 int
271 bond_ethdev_parse_bond_mac_addr_kvarg(const char *key __rte_unused,
272  const char *value, void *extra_args);
273 
274 int
275 bond_ethdev_parse_time_ms_kvarg(const char *key __rte_unused,
276  const char *value, void *extra_args);
277 
278 void
279 bond_tlb_disable(struct bond_dev_private *internals);
280 
281 void
282 bond_tlb_enable(struct bond_dev_private *internals);
283 
284 void
285 bond_tlb_activate_slave(struct bond_dev_private *internals);
286 
287 void
288 bond_ethdev_stop(struct rte_eth_dev *eth_dev);
289 
290 void
291 bond_ethdev_close(struct rte_eth_dev *dev);
292 
293 #endif
Generated by   doxygen 1.8.1.2