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